<!doctype html>
<html lang="zh-CN">
  <head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
    <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/css/bootstrap.min.css" integrity="sha384-MCw98/SFnGE8fJT3GXwEOngsV7Zt27NXFoaoApmYm81iuXoPkFOJwJ8ERdknLPMO" crossorigin="anonymous">
    <link rel="stylesheet" href="/js/prism.css">
    <link rel="stylesheet" href="/css/app.css">
    <title>Panda-api中文说明 - 叫兽</title>
    <link rel="icon" type="image/x-icon" class="js-site-favicon" href="/img/favicon.ico">
  </head>
  <body>

        <div class="container bg-white pb-5 px-5 spx-0">
            
            <h1 class="post-title">Panda-api中文说明</h1>




            <p>Panda api是一个简单快速的前后端接口文档管理工具，</p><p>现在的随着js和js的相关前端框架，移动App的发展，各类软件系统越来越使用前后端分离的方式进行开发。前端和后端被分离为了两个不同的工种，不通工种之间就需要进行交流沟通协作，但是前后端分离开发我一直找不到一个满足我需求的工具。</p><p>传统的API 文档虽然满足了阅读者对接接口的需求，但是通常需要等待后端开发完成才能调用接口，从而真正开始接口调试工作。</p><p>如果要让两个工种同时并发的进行开发，就需要前端后端达成接口的约定，也就是接口文档。如果我们提前编写出接口文档，用接口文档就可以分别对前后端进行服务，通过接口文档分隔前后端，那么前后端就可以按照这个接口文档的约定进行开发，开发效率就会大大提升，同时在开发过程中保留了宝贵的接口文档。</p><p>Panda Api 接口文档的工具满足以下几个特性：</p><ol><li>提供一份可以前后端浏览的接口文档</li><li>使用json或json5语法来写文档，操作成本、学习成本非常低</li><li>接口文档也可以像代码一样进行版本控制，前后端都有维护的权限。Panda api依赖git等版本管理工具来做</li><li>可以在定义好文档后，立即为前端开发提供接口服务，不用等待后端开发完成。为前端支持各类请求:GET, POST, PUT, DELETE, OPTIONS</li><li>可以使用这个工具进行前端测试和后端测试</li><li>可以像Mock一样，自动生成相关测试数据</li><li>支持多种开发环境切换，例如开发环境、测试环境、正式环境</li><li>支持websocket方式为前端开发提供测试接口服务；支持用websocket方式作为客户端进行后端服务测试</li></ol><p>话不多说，大家试一试吧，有任何意见建议，欢迎交流。</p><p>这个工具的从想法到实现，一共用了两个星期的下班业余时间来做。前端展现上还在开发完善中，但是功能已能够满足前后端接口文档的编写，满足前端快速开发的需求。</p><h3>Demo演示</h3><p><a href='http://139.155.127.14:9000/'>Demo版本</a><br /></p><h3>带有样例的使用包下载</h3><p><a href='https://github.com/arlicle/panda-api/releases/download/0.2/panda-api_mac_0.2.tar'>Panda Api for Mac 0.2</a><br /> <a href='https://github.com/arlicle/panda-api/releases/download/0.2/panda-api_linux_0.2.tar'>Panda Api for Linux 0.2</a><br /> <a href='https://github.com/arlicle/panda-api/releases/download/0.2/panda-api_windows_0.2.tar'>Panda Api for Windows 0.2</a></p><h3>使用文档</h3><p><a href='https://www.debugmyself.com/p/2020/1/15/Panda-api%E4%BD%BF%E7%94%A8%E8%AF%B4%E6%98%8E/'>使用说明(一)</a><br /> <a href='https://www.debugmyself.com/p/2020/1/15/Panda-api%E9%AB%98%E7%BA%A7%E4%BD%BF%E7%94%A8%E8%AF%B4%E6%98%8E/'>使用说明(二)</a><br /> <a href='https://www.debugmyself.com/p/2020/1/29/Panda-api%E5%AD%97%E6%AE%B5%E8%AF%B4%E6%98%8E/'>相关字段说明</a>  <br /> <a href='https://www.debugmyself.com/p/2020/1/27/Panda-api-test_data%E5%8C%B9%E9%85%8D%E8%AF%B4%E6%98%8E/'>test_data使用说明</a>  <br /> <a href='https://www.debugmyself.com/p/2020/1/17/Mac%E4%B8%8B%E5%AE%89%E8%A3%85Panda-Api/'>Mac下安装配置</a>    <br /> <a href='https://www.debugmyself.com/p/2020/1/18/Windows%E4%B8%8B%E5%AE%89%E8%A3%85Panda-Api/'>Windows下安装配置</a>  <br /></p><h2>Examples</h2><ol><li><a href='https://github.com/arlicle/panda-api-examples/tree/master/basics'>Basics</a></li><li><a href='https://github.com/arlicle/panda-api-examples/tree/master/inherit_models'>Inherit from models</a></li><li><a href='https://github.com/arlicle/panda-api-examples/tree/master/global_settings'>Global field settings</a></li></ol>
            <p class="text-left text-muted">2020-01-31 02:01</p>
        </div>
        <div class="container">
            <div class="row mt-4">
                <div class="col-6 text-left"><a href="/p/2020/1/27/Panda-api-test_data匹配说明/">上一篇: Panda-api test_data匹配说明</a></div>
                <div class="col-6 text-right"><a href="/p/2020/1/18/Windows下安装Panda-Api/">下一篇:Windows下安装Panda Api</a></div>
            </div>
        </div>

        <button class="btn btn-link m-menu-toggle d-md-none fixed-top collapsed" type="button" data-toggle="collapse" data-target="#m-menu" aria-controls="m-menu" aria-expanded="false" aria-label="Toggle docs navigation"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 30 30" width="30" height="30" focusable="false"><title>Menu</title><path stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-miterlimit="10" d="M4 7h22M4 15h22M4 23h22"></path></svg>
        </button>
        <ul class="nav flex-column collapse fixed-top site-menu d-md-block" id="m-menu">
            <li class="nav-item">
                <a class="nav-link" href="/">首页</a>
            </li>
            <li class="nav-item">
                <a class="nav-link" href="/p/list/">所有文章</a>
            </li>
            <li class="nav-item">
                <a class="nav-link" href="/p/about-me/">关于我</a>
            </li>
            <li class="nav-item">
              <a class="nav-link" href="https://github.com/arlicle">Github</a>
          </li>
        </ul>

        
    <div class="container mt-5">
        <h3>留言</h3>
        <div id="commentApp"></div>
    </div>
    <script>
        var AL_configs = {
            "post_id":"/p/2020/1/24/Panda-api中文说明/",
            "appid":"847e226e8a46f64045d45312245a68ba1368a564"
        };
        (function() {
            var hm = document.createElement("script");
            hm.src = "https://comment.debugmyself.com/sc.js";
            var s = document.getElementsByTagName("script")[0];
            s.parentNode.insertBefore(hm, s);
        })();
    </script>


        <footer class="footer mt-5 pb-2">
        <div class="container text-center">
          
          <p><span class="text-black-50">Powered by <a href="https://github.com/arlicle/ablog">ablog</a> © 2019 叫兽</span></p>
          <p><span class="text-black-50"><a href="http://www.beian.miit.gov.cn/">滇ICP备10201832号-3</a></span></p>
          
        </div>
        </footer>
        <script src="https://code.jquery.com/jquery-3.3.1.slim.min.js" integrity="sha384-q8i/X+965DzO0rT7abK41JStQIAqVgRVzpbzo5smXKp4YfRvH+8abtTE1Pi6jizo" crossorigin="anonymous"></script>
        <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.3/umd/popper.min.js" integrity="sha384-ZMP7rVo3mIykV+2+9J3UJ46jBk0WLaUAdn689aCwoqbBJiSnjAK/l8WvCWPIPm49" crossorigin="anonymous"></script>
        <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/js/bootstrap.min.js" integrity="sha384-ChfqqxuZUCnJSK3+MXmPNIyE6ZbWh2IMqE241rYiqJxyMiZ6OW/JmZQ5stwEULTy" crossorigin="anonymous"></script>
        <script src="/js/prism.js"></script>
        <script>
        $(function () {
            $('[data-toggle="tooltip"]').tooltip();
        })
        </script>
        <script type="text/x-mathjax-config">
        MathJax.Hub.Config({tex2jax: {inlineMath: [['$','$'], ['\\(','\\)']]}, displayAlign: "left",scale: 180});
        </script>
        <script type="text/javascript" async
        src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js?config=TeX-MML-AM_SVG" async>
        </script>
  </body>
</html>